Skip to content

fix(rst): ensure blank line before bullet lists#58760

Merged
potiuk merged 1 commit intoapache:mainfrom
moon-jam:fix-rst-unexpected-bullet-format
Nov 28, 2025
Merged

fix(rst): ensure blank line before bullet lists#58760
potiuk merged 1 commit intoapache:mainfrom
moon-jam:fix-rst-unexpected-bullet-format

Conversation

@moon-jam
Copy link
Contributor

@moon-jam moon-jam commented Nov 27, 2025

Why

Notice that #58748 fixed a bullet points rendering issue caused by missing blank lines before *, but some files still have the same problem. This PR adds a fix for them.

For example:
image

How

I used a simple script below to check that bullet points render properly and fixed them manually.

Script to find bullet points format error 
from pathlib import Path


def is_bullet_line(line: str) -> bool:
    return line.startswith("* ")


def is_blank(line: str) -> bool:
    return line.strip() == ""


def main():
    for rst in Path(".").rglob("*.rst"):
        lines = rst.read_text(encoding="utf-8").splitlines()

        for i, line in enumerate(lines):
            if not is_bullet_line(line):
                continue

            if i == 0:
                continue

            prev = lines[i - 1]

            if is_blank(prev):
                continue
            if (
                prev.startswith("*")
                or prev.startswith(" ")
                or prev.startswith("=")
                or prev.startswith("''")
                or prev.startswith("~")
                or prev.startswith("-")
            ):
                continue

            print(f"{rst}:{i + 1}: " f'bullet "*" should be preceded by a blank line')


if __name__ == "__main__":
    main()

Optional / Future

  • Maybe I could integrate a rst linter in pre-commit hook later.

@moon-jam
fix(rst): ensure blank line before bullet lists
64df99a 
Using script to ensure all .rst files in the project have a blank line before "* " bullet lists.

This prevents formatting issues similar to apache#58748.
@boring-cyborg
Copy link

boring-cyborg bot commented Nov 27, 2025

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our prek-hooks will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@boring-cyborg boring-cyborg bot added area:airflow-ctl area:dev-tools area:providers backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch kind:documentation provider:google Google (including GCP) related issues labels Nov 27, 2025
@uranusjr uranusjr added the type:doc-only Changelog: Doc Only label Nov 27, 2025
@potiuk potiuk merged commit fe80fed into apache:main Nov 28, 2025
71 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented Nov 28, 2025

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

@github-actions
Copy link

github-actions bot commented Nov 28, 2025

Backport failed to create: v3-1-test. View the failure log Run details

Status Branch Result
❌ v3-1-test Commit Link

You can attempt to backport this manually by running:

cherry_picker fe80fed v3-1-test

This should apply the commit to the v3-1-test branch and leave the commit in conflict state marking
the files that need manual conflict resolution.

After you have resolved the conflicts, you can continue the backport process by running:

cherry_picker --continue

RoyLee1224 pushed a commit to RoyLee1224/airflow that referenced this pull request Dec 3, 2025
@moon-jam @RoyLee1224
fix(rst): ensure blank line before bullet lists (apache#58760)
80b32ab 
Using script to ensure all .rst files in the project have a blank line before "* " bullet lists.

This prevents formatting issues similar to apache#58748.
Copilot AI pushed a commit to jason810496/airflow that referenced this pull request Dec 5, 2025
@moon-jam
fix(rst): ensure blank line before bullet lists (apache#58760)
385ecb6 
Using script to ensure all .rst files in the project have a blank line before "* " bullet lists.

This prevents formatting issues similar to apache#58748.
itayweb pushed a commit to itayweb/airflow that referenced this pull request Dec 6, 2025
@moon-jam @itayweb
fix(rst): ensure blank line before bullet lists (apache#58760)
edec6b9 
Using script to ensure all .rst files in the project have a blank line before "* " bullet lists.

This prevents formatting issues similar to apache#58748.
@bugraoz93 bugraoz93 mentioned this pull request Jan 9, 2026
Closed
24 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@potiuk potiuk potiuk approved these changes

@uranusjr uranusjr uranusjr approved these changes

@choo121600 choo121600 choo121600 approved these changes

@bugraoz93 bugraoz93 Awaiting requested review from bugraoz93 bugraoz93 is a code owner

Assignees

No one assigned

Labels

area:airflow-ctl area:dev-tools area:providers backport-to-v3-1-test Mark PR with this label to backport to v3-1-test branch kind:documentation provider:google Google (including GCP) related issues type:doc-only Changelog: Doc Only

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@moon-jam @potiuk @uranusjr @choo121600